Skip to content

docs: Remove V2 code examples from V3 documentation - #6271

Merged
lucasjia-aws merged 1 commit into
aws:masterfrom
lucasjia-aws:docs/remove-v2-code-examples-from-v3-rtd
Sep 14, 2026
Merged

lucasjia-aws merged 1 commit into
aws:masterfrom
lucasjia-aws:docs/remove-v2-code-examples-from-v3-rtd

Conversation

@lucasjia-aws

Copy link
Copy Markdown
Collaborator

The V3 documentation site showed side-by-side V2/V3 code blocks on the Training, Inference, MLOps, and Lineage Tracking pages. The V2 blocks are complete, runnable examples using removed APIs (Estimator, Model, Predictor, sagemaker.workflow, SKLearnProcessor, sagemaker.lineage), so readers and crawlers could copy code that does not run on V3.

Remove the V2 blocks and keep only the V3 examples:

  • training/index.rst: drop the Estimator/estimator.fit() quick start
  • inference/index.rst: drop the Model/Predictor/predictor.predict() block
  • ml_ops/index.rst: drop the "Traditional Pipeline Approach" block
  • ml_ops/lineage.rst: drop all 9 "V2 (Legacy)" blocks in Use Cases 1-9

On the Lineage page the V2 and V3 blocks were identical apart from the import path, so no information is lost. Where a lead-in sentence framed a V2-to-V3 comparison, it is rewritten to describe the V3 example directly.

The V2-to-V3 API mapping tables are intentionally left in place; they are tracked separately for a possible move into migration.md.

Issue #, if available:

Description of changes:

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

The V3 documentation site showed side-by-side V2/V3 code blocks on the
Training, Inference, MLOps, and Lineage Tracking pages. The V2 blocks are
complete, runnable examples using removed APIs (Estimator, Model,
Predictor, sagemaker.workflow, SKLearnProcessor, sagemaker.lineage), so
readers and crawlers could copy code that does not run on V3.

Remove the V2 blocks and keep only the V3 examples:

- training/index.rst: drop the Estimator/estimator.fit() quick start
- inference/index.rst: drop the Model/Predictor/predictor.predict() block
- ml_ops/index.rst: drop the "Traditional Pipeline Approach" block
- ml_ops/lineage.rst: drop all 9 "V2 (Legacy)" blocks in Use Cases 1-9

On the Lineage page the V2 and V3 blocks were identical apart from the
import path, so no information is lost. Where a lead-in sentence framed a
V2-to-V3 comparison, it is rewritten to describe the V3 example directly.

The V2-to-V3 API mapping tables are intentionally left in place; they are
tracked separately for a possible move into migration.md.
@lucasjia-aws
lucasjia-aws merged commit fbc2c52 into aws:master Sep 14, 2026
6 checks passed

This branch was successfully deployed

1 active deployment
auto-approve 785a89c7 Deployed Sep 14, 2026 by lucasjia-aws via wait-for-approval #1433
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants